home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / chang402.zip / CHANGE.DOC < prev    next >
Text File  |  1994-01-30  |  16KB  |  313 lines
  1. CHANGE.DOC
  2. 01/30/94
  3.  
  4. The CHANGE.EXE program allows you to make changes in binary or text files of any
  5. size.  Features:
  6.  
  7.   * Can handle files of any size provided you have enough room on your disk
  8.     to hold a copy of resulting file
  9.   * Can be used to change text files or binary files
  10.   * Can be used to remove trailing spaces from a file
  11.   * Can specify different lengths for the input strings and the output strings
  12.   * Can specify that the changes only be done in lines that include a certain
  13.     character string.  This selection string can be case-insensitive
  14.   * Can handle up to 25 change requests at a time
  15.   * Can specify the input/output strings as ASCII characters, hexadecimal
  16.     values, or as decimal values
  17.   * Handles the changes fairly quickly
  18.   * Can either replace the original file with the resulting file or else
  19.     create a new changed file (using /Noutfile specification)
  20.   * Changes can be verified before they are made
  21.   * Changes can be entered in any of the following ways:
  22.       - from the command line (one TO/FROM pair allowed)
  23.       - interactively (one TO/FROM pair allowed)
  24.       - from a controlfile (up to 25 TO/FROM pairs allowed)
  25.   * Boolean operators can be used if the TO/FROM pair is specified from the
  26.     command line (e.g. CHANGE TEST.TXT /FROM One /TO Many /IN Apples OR Oranges
  27.  
  28.  
  29. Program written by:
  30.                         Bruce Guthrie
  31.                         Room H-4885
  32.                         U.S. Dept of Commerce/ESA/OBA/BSISD
  33.                         Washington, D.C. 20230
  34.  
  35.                         (202) 482-3234
  36.  
  37. You may freely copy and re-distribute this program; however, the U.S.
  38. Department of Commerce neither guarantees nor assures compatibility of the
  39. program with all computer software or hardware.
  40.  
  41. Foreign users:  Please provide an Internet address in all correspondence or
  42. and just e-mail your problems to me at bgu@cu.nih.gov
  43.  
  44.  
  45. Syntax:
  46.  
  47.     CHANGE infile [ ctlfile | /Cctlfile |
  48.       /FROM string /TO string [ /IN search ] ]
  49.       [ /LINES { line1-line2 | line1 linect } ... ] [ /V | /-V ] [ /I | /-I ]
  50.       [ /Noutfile [ /OVERWRITE | /-OVERWRITE | /OVERASK ] ]
  51.       [ /Fflagfile ] [ /Ttempfile ] [ /TRIM | /-TRIM ]
  52.       [ /BINARY | /TEXT ] [ /VERIFY | /-VERIFY ] [ /Q ] [ /? | /?&H ]
  53.  
  54.  
  55. where:
  56.  
  57. "infile" can include a drive and path designation.  It is the file name you
  58. want changed.  Unless you specify a /Noutfile parameter, the infile will be
  59. overwritten by this program.
  60.  
  61. "ctlfile" contains the change commands to make.  If a ctlfile is not provided
  62. and a FROM/TO option is not specified, the routine will prompt you for one FROM
  63. (what's the text you want to change from; case is significant unless /CASE is
  64. specified), TO (what's the text you want to change to; case is always
  65. significant), and IN (what string the line must be contain before the change is
  66. applied; case is always significant unless /CASE is specified) request.  If a
  67. ctlfile is used, you can specify up to 25 change requests at a time.  Each line
  68. of the change file should consist of records of one of four record types:
  69.  
  70.   * blank lines or those beginning with semi-colons are treated as comments.
  71.   * lines beginning with "-F" or "-f" provide FROM options.
  72.   * lines beginning with "-T" or "-t" provide TO options.
  73.   * lines beginning with "-I" or "-i" provide IN options.  These are optional;
  74.     if not provided, all lines will be searched for the FROM string.  Any
  75.     IN request forces /TEXT mode to be invoked
  76.  
  77. If more than one set of FROM/TO/IN records is provided, the -F specification
  78. must precede the others.  Each option is local to a given FROM/TO/IN
  79. specification.  For example:
  80.  
  81.         ; Sample file
  82.         -FPRINT
  83.         -TPrinting
  84.         -I"
  85.         -fUSING
  86.         -tused
  87.  
  88. contains two FROM/TO/IN specifications.  "PRINT" will be changed to "Printing"
  89. in any line with a double quote.  "USING" will be changed to "used" in all
  90. lines; no -I option is applied for the second FROM/TO/IN specification.
  91.  
  92. The FROM/TO/IN specifications can include any text characters.  They can also
  93. contain ASCII codes, created either using the Alt key in combination with the
  94. numeric keypad (e.g.  Alt-228 to get a Sigma character) or else by imbedding a
  95. hexadecimal code (in the form &Hxx) or a decimal code (in the form \nnn) in the
  96. text.  You can get a table of hexadecimal codes at the end of this documentation
  97. or by saying "CHANGE /?&H".  For example, to change a double carriage
  98. return/line feed to a single carriage return/line feed, you could say:
  99.  
  100.         -F&H0D0A0D0A
  101.         -T&H0D0A
  102.  
  103. (Note that the above example would require you to use the /BINARY option as well
  104. since it extends beyond line boundaries.)
  105.  
  106. If you need to follow a hexadecimal specification with normal text characters,
  107. follow the hex spec with one space (which CHANGE will ignore).  For example,
  108.  
  109.         -F&H0c Hi!
  110.         -T&H0d0a Bye!
  111.  
  112.  
  113. "/Cctlfile" is the same as "ctlfile" separately but, unlike the letter,
  114. "/Cctlfile" is not position dependent.  It can appear anywhere in the command
  115. line string.
  116.  
  117. "/FROM string /TO string [ /IN search ]" allows you to specify the from/to
  118. parameters on the control line.  Quotation marks are required around the strings
  119. if they include spaces or special characters.  Note that certain characters
  120. cannot be passed in because DOS considers them special characters and steals
  121. them first.  This includes ">" and "|" characters.  You'll have to use the
  122. control file or the interactive mode in this case or else use the &Hxx or \nnn
  123. conventions.  "search" is further described below.
  124.  
  125. "/LINES line1-line2" says to restrict the search to lines between line numbers
  126. line1 and line2 inclusive.  You can have multiple line requests in any order
  127. such as "/LINES 1-10 90-100 30-50".  The routine skips all lines after the
  128. largest line number is encountered.  Defaults to "/LINES 1-9999999".
  129.  
  130. "/LINES line1 linect" says to restrict the search to lines beginning with line1
  131. and continuing for a total of linect lines.  So "/LINES 10 20" is actually the
  132. same as "/LINES 10-29".
  133.  
  134. "/V" says to find those items that do NOT match the specification.
  135.  
  136. "/-V" is the opposite of /V and is typically the default; CONFIGWS-able.
  137.  
  138. "/I" says to make it a case-insensitive search.
  139.  
  140. "/-I" is the opposite of /I and is typically the default; CONFIGWS-able.
  141.  
  142. "/Noutfile" is the name of the new file to create.  If a /Noutfile is not
  143. specified, the source document (infile) will be replaced by the changed file.
  144.  
  145. "/OVERWRITE" says to write over the outfile (if requested) if it exists
  146. already.
  147.  
  148. "/-OVERWRITE" says to abort if the outfile exists already.
  149.  
  150. "/OVERASK" says to ask if the outfile exists already.  This is the default.
  151.  
  152. "/Fflagfile" is the name of a file to contain all changed lines.  This allows
  153. you to see what the lines were changed to for verification purposes.  This
  154. option automatically invokes /TEXT.
  155.  
  156. "/Ttempfile" is the name of the temporary file to create.  The actual changes
  157. are written to a temp file and then the source file is replaced with the temp
  158. file is everything works and there were actually changes to be found in the
  159. source document.  By default, the temp file is written to the same path as the
  160. input file.  The temporary file will be as big as the final file is.  If you
  161. don't have enough room for it to be on your source disk, specify another
  162. temporary file name with a different path (e.g. "/TG:\TEMP.TXT").
  163.  
  164. "/TRIM" says to remove trailing spaces from the end of each line.  Automatically
  165. forces you into TEXT mode.
  166.  
  167. "/-TRIM" is the opposite of /TRIM and is the default.
  168.  
  169.  
  170. "/TEXT" puts you into TEXT mode.  TEXT mode means that all data in the file are
  171. read in and processed as separate text records.  Alternatively, the file can be
  172. processed in BINARY mode in which case the file is read in in 8,000-byte blocks.
  173. BINARY mode is quicker and is required for EXE and COM files.  TEXT mode
  174. presents some information like the number of lines in your file and is
  175. *required* if you specify any of the following options:
  176.  
  177.         * an IN (or